API Reference

allxon_infrasturcture

Glossary of Terms

Term	Description
Allxon Cloud	The backend servers of Allxon service; both Allxon Portal and Allxon Agent are connected to Allxon Cloud.
Allxon Portal	The frontend servers of Allxon service.
Allxon Agent	An agent application that communicates between edge devices and Allxon Cloud.
Plugin	A software application that extends the functionalities of Allxon service. A plugin sends collected data from modules to Allxon Cloud via Allxon Agent. It also sends commands from Allxon Portal to modules via Allxon Agent.
Module	A hardware component (e.g. GPU, SSD, fan) or a software application (e.g. remote console utilities). A plugin collects data from a module or sends commands to a module.
MQTT Broker	Allxon Agent connects to a MQTT broker hosted by Allxon Cloud. All the data exchange between Allxon Agents and Allxon Cloud go through this channel.
WebSocket Server	A plugin connects to a WebSocket server hosted within an Allxon Agent. The plugin sends and receives data to/from Allxon Cloud with Allxon Octo APIs through this channel.
Allxon Octo API	The Application Programming Interface used to communicate between Allxon Agent and plugins.
Allxon Octo SDK	The Software Development Kit provided by Allxon, which helps developers to build plugins and verify Allxon Octo APIs.
App GUID	A unique identifier assigned by Allxon to each plugin in UUIDv4 format.
Access Key	A secret key assigned by Allxon to each plugin for message signing.

Allxon Octo API

Allxon Octo API adopts JSON-RPC 2.0 specification over WebSocket. To communicate with Allxon Agent, you need to create a WebSocket connection wss://localhost:55688 from the plugin. Then send/receive requests in the JSON format via the API.

note

Each API maximum payload size is 5 KB.

note

JSON-RPC batch is not supported.

How to Read the API

If the API name starts with notify..., it's a JSON-RPC Notification Request.
A bracketed JSON Key represents a JSON Type. The types are as follows: Object, Array, String, Number, Bool, Null
If a JSON Key is not bracketed, the JSON Type is String.

`"v2/notifyPluginUpdate"`

Direction: Plugin → Agent

{
    "jsonrpc": "2.0",
    "method": "v2/notifyPluginUpdate",
    "params": {
        "appGUID": "...",
        "epoch": "...",
        "appName": "...",
        "displayName": "...",
        "type": "...",
        "sdk": "...",
        "version": "...",
        "startCommand": "...",
        "stopCommand": "...",
        "modules": [
            {
                "moduleName": "...",
                "displayName": "...",
                "description": "...",
                "properties": [ ... ],
                "states": [ ... ],
                "metrics": [ ... ],
                "events": [ ... ],
                "commands": [ ... ],
                "alarms": [ ... ],
                "configs": [ ... ]
            }
        ]
    }
}

`$.params`

Name	Type	Description
`"appGUID"`	String	The GUID of the plugin.
`"appName"`	String	The unique plugin name in string format. The name must match the regular expression¹.
`"epoch"`	String	The current Epoch Time in seconds.
`"displayName"`	String	The plugin name displayed on the plugIN card.
`"type"`	String	`"ib"` for in-band plugin. `"oob"` for out-of-band plugin.
`"sdk"`	String	The version of Allxon Octo SDK, which follows semantic version rule.
`"version"`	String	The version of a plugin, which uses a sequence of three digits (Major.Minor.Patch). It must match the regular expression².
`"startCommand"`	String	A Command to execute when plugin starts.
`"stopCommand"`	String	A Command to execute when plugin stops.
`"modules"`	Array	A set of hardware or software modules controlled by this plugin.

`$.params.modules[*]`

Name	Type	Description
`"moduleName"`	String	The module name unique within the plugin and having a string format of no longer than 64 characters. The name must match the regular expression.
`"displayName"`	String	The module name displayed on the plugin tab of the device page.
`"description"`	String	The description of the module.
`"properties"`	Array	This is used to upload the static information of the module, such as the firmware version and hardware configuration.
`"states"`	Array	This is used to upload the dynamic states of the module, such as the power state.
`"metrics"`	Array	This is used to upload metrics of the module, such as temperature and voltage.
`"events"`	Array	This is used to upload events/activities of the module, such as intrusion detection.
`"commands"`	Array	This is used to enable function calls of the module, such as power cycling and hardware configuration.
`"alarms"`	Array	This is used to handle alerts of the module, such as alerts for CPU and system temperature.
`"configs"`	Array	This is used to handle the remote configurations of the module, such as scheduling.

`$.params.modules[].properties[]`

{
  "name": "...",
  "displayName": "...",
  "displayCategory": "...",
  "description": "...",
  "displayType": "...",
  "value": "..."
}

Name	Type	Description
`"name"`	String	The property name unique within the module and having a string format of no longer than 32 characters. The name must match the regular expression¹.
`"displayName"`	String	The display name of each property field.
`"displayCategory"`	String	The name of the Category tab displayed on a card. Properties with the same displayCategory are categorized under the same tab.
`"description"`	String	The description of the property.
`"displayType"`	String	`"string"` \| `"table"` \| `"link"`
`"value"`	Object \| Array \| String	The type of `"value"` depends on the `"displayType"`.

`"displayType":"string"` in `"properties"`

In Properties, if the "displayType" is set to "string", the type of "value" must be String.

Here is an example:

v2/notifyPluginUpdate.json
{
    ...
    "properties": [
        {
            "name": "property1",
            "displayType": "string",
            "value": "my string",
            ...
        },
        ...
    ]
}

The Properties card displays as follows:

property-display-type-string

`"displayType":"link"` in `"properties"`

If the "displayType" is set to link, the type of "value" must be Object and must follow the format below.

Name	Type	Required	Description
`"url"`	String		A link to an external resource.
`"alias"`	String		An alias name for this URL.

Here is an example:

v2/notifyPluginUpdate.json
{
    ...
    "properties": [
        {
            "name": "property1",
            "displayType": "link",
            "value": {
                "url": "https://www.google.com",
                "alias": "Google Site"
            },
            ...
        },
        ...
    ]
}

The Properties card displays as follows:

property-display-type-link

`"displayType":"table"` in `"properties"`

When the "displayType" is set to table, the type of "value" must be Array.

Here is an example:

v2/notifyPluginUpdate.json
{
    ...
    "properties": [
        {
            "name": "property1",
            "displayType": "table",
            "value": [
                {
                    "header1": "row1 column1",
                    "header2": "row1 column2"
                },
                {
                    "header1": "row2 column2",
                    "header2": "row2 column2"
                },
                ...
            ],
            ...
        },
        ...
    ]
}

The Properties card displays as follows:

property-display-type-table

Click the table icon to view details. property-display-type-table-popup

`$.params.modules[].states[]`

{
  "name": "...",
  "displayName": "...",
  "displayCategory": "...",
  "description": "...",
  "displayType": "..."
}

Name	Type	Description
`"name"`	String	The state name unique within the module and having a string format of no longer than 32 characters. The name must match the regular expression¹.
`"displayName"`	String	The field name displayed under the state.
`"displayCategory"`	String	The name of the Category tab displayed on a card. States with the same displayCategory are categorized under the same tab.
`"description"`	String	The description of the state.
`"displayType"`	String	`"string"` \| `"table"` \| `"link"`

`$.params.modules[].metrics[]`

{
  "name": "...",
  "displayName": "...",
  "displayCategory": "...",
  "description": "...",
  "displayUnit": "...",
  "displayType": "..."
}

Name	Type	Required	Description
`"name"`	String		The name of the set of metrics, which is unique within the module and having a string format of no longer than 32 characters. The name must match the regular expression1.¹.
`"displayName"`	String		The field name displayed under the metrics.
`"displayCategory"`	String		The name of the Category tab displayed on a card. Metrics with the same displayCategory are categorized under the same tab.
`"description"`	String		The description of the metric.
`"displayUnit"`	String	Depending on `"displayType"`	If the `"displayType"` is `"custom"`, the display unit should be entered.
`"displayType"`	String		`"temperature"` \| `"custom"`

`$.params.modules[].events[]`

{
  "name": "...",
  "displayName": "...",
  "displayCategory": "...",
  "description": "..."
}

Name	Type	Description
`"name"`	String	The event name unique within the module and having a string format of no longer than 32 characters. The name must match the regular expression¹.
`"displayName"`	String	The field name displayed under the event
`"displayCategory"`	String	The name of the Category tab displayed within a card. Events with the same displayCategory are categorized under the same tab.
`"description"`	String	The description of the event.

`$.params.modules[].commands[]`

{
    "name": "...",
    "displayCategory": "...",
    "displayName": "...",
    "description": "...",
    "type": "...",
    "params": [
        {
            "name": "...",
            "displayName": "...",
            "description": "...",
            "displayType": "...",
            "required": true | false,
            "requiredOn": "...",
            "defaultValue": "...",
            "displayMask": "...",
            "valueEncoding": "..."
        }, ...
    ]
}

Name	Type	Description
`"name"`	String	The command name unique within the module and having a string format of no longer than 32 characters. The name must match the regular expression¹.
`"displayCategory"`	String	The name of the Category tab displayed on a card. Commands with the same displayCategory are categorized under the same tab.
`"displayName"`	String	The field name under the command.
`"description"`	String	The description of the command.
`"type"`	String	`"asynchronous"`
`"displayOnProperty"`	Object	(This function is only used in special scenarios. Contact your Allxon representative for instructions.)
`"params"`	Array	(No need to set this item if this command has no parameters.)

`$.params.modules[].commands[].params[*]`

Name	Type	Required	Description
`"name"`	String		The command parameter name unique within the command and having a string format of no longer than 32 characters. The name must match the regular expression¹.
`"displayName"`	String		The field name under the command parameter.
`"description"`	String		The description of the command parameter.
`"displayType"`	String		`"string"` \| `"text"` \| `"datetime"` \| `"switch"` \| `"checkbox"` \| `"list"` \| `"tos"`
`"required"`	Bool		Indicates if this parameter is mandatory or not.
`"requiredOn"`	String		Indicates if this parameter is mandatory on the other parameter.
`"displayValues"`	String \| Array		Related to the `"displayType"`.
`"defaultValue"`	String		The default value of this parameter.
`"displayFormat"`	String	Depending on `"displayType"`	A property for the `"datetime"` displayType. Refer to the datetime format.
`"valueFromProperty"`	String		(This function is only used in special scenarios. Contact your Allxon representative for instructions.)
`"displayMask"`	Bool		(Not implemented in the Portal yet.)
`"valueEncoding"`	String		Advance

`$.params.modules[].alarms[]`

{
    "name": "...",
    "displayCategory": "...",
    "displayName": "...",
    "description": "...",
    "params": [
        {
            "name": "...",
            "displayName": "...",
            "description": "...",
            "displayType": "...",
            "required": true | false,
            "displayValues": "...",
            "defaultValue": "...",
            "displayFormat": "...",
            "valueFromProperty": "...",
            "displayMask": "...",
            "valueEncoding": "..."
        }, ...
    ]
}

Name	Type	Description
`"name"`	String	The alarm name unique within the module and having a string format of no longer than 32 characters. The name must match the regular expression¹.
`"displayCategory"`	String	The name of the category tab displayed on a card.Alarms with the same displayCategory are categorized under the same tab.
`"displayName"`	String	The field name displayed under the alarm.
`"description"`	String	The description of the alarm.
`"params"`	Array	(No need to set this item if this alarm has no parameters.)

`$.params.modules[].alarms[].params[*]`

Name	Type	Required	Description
`"name"`	String		The parameter name unique within the alarm and having a string format of no longer than 32 characters. The name must match the regular expression¹.
`"displayName"`	String		The field name displayed under the alarm parameter.
`"description"`	String		The description of the alarm parameter.
`"displayType"`	String		`"string"` \| `"datetime"` \| `"switch"` \| `"checkbox"` \| `"list"` \| `"temperature"`
`"required"`	Bool		Indicates if this parameter is mandatory or not.
`"displayValues"`	String		Related to the `"displayType"`.
`"defaultValue"`	String		The default value of this parameter.
`"displayFormat"`	String	Depending on `"displayType"`	A required property if the displayType is `"datetime"`. Refer to the datetime format.
`"valueFromProperty"`	String		(This function is only used in special scenarios. Contact your Allxon representative for instructions.)
`"displayMask"`	Bool		A property for the `"string"` displayType, indicating if the string inputs are masked or not.
`"valueEncoding"`	String		(This function is only used in special scenarios. Contact your Allxon representative for instructions.)

`$.params.modules[].configs[]`

{
    "name": "...",
    "displayCategory": "...",
    "displayName": "...",
    "description": "...",
    "params": [
        {
            "name": "...",
            "displayName": "...",
            "description": "...",
            "displayType": "...",
            "required": true | false,
            "displayValues": "...",
            "defaultValue": "...",
            "displayFormat": "...",
            "valueFromProperty": "...",
            "displayMask": "...",
            "valueEncoding": "..."
        }, ...
    ]
}

Name	Type	Description
`"name"`	String	The config name unique within the module and having a string format of no longer than 32 characters. The name must match the regular expression¹.
`"displayCategory"`	String	The name of the category tab displayed on a card. Configs with the same displayCategory are categorized under the same tab.
`"displayName"`	String	TThe field name displayed under the config.
`"description"`	String	The description of the config.
`"params"`	Array	(No need to set this item if this config has no parameters.)

`$.params.modules[].configs[].params[*]`

Name	Type	Required	Description
`"name"`	String		The command parameter name unique within the config and having a string format of no longer than 32 characters. The name must match the regular expression¹.
`"displayName"`	String		The field name under the config parameter.
`"description"`	String		The description of the config parameter.
`"displayType"`	String		`"string"` \| `"datetime"` \| `"switch"` \| `"checkbox"` \| `"list"` \| `"temperature"`
`"required"`	Bool		Indicates if this parameter is mandatory or not.
`"displayValues"`	String		Related to the `"displayType"`
`"defaultValue"`	String		Default value of this parameter.
`"displayFormat"`	String	Depending on `"displayType"`	A property for the `"datetime"` displayType. Refer to the datetime format.
`"valueFromProperty"`	String		(This function is only used in special scenarios. Contact your Allxon representative for instructions.)
`"displayMask"`	Bool		A property for the `"string"` displayType, indicating if the string inputs are masked or not.
`"valueEncoding"`	String		(This function is only used in special scenarios. Contact your Allxon representative for instructions.)

`"v2/notifyPluginCommand"`

Direction: Agent → Plugin

{
    "jsonrpc": "2.0",
    "method": "v2/notifyPluginCommand",
    "params": {
        "serialNumber": "...",
        "appGUID": "...",
        "epoch": "...",
        "commandId": "...",
        "commandSource": "...",
        "moduleName": "...",
        "commands": [ ... ]
    }
}

`$.params`

Name	Type	Description
`"serialNumber"`	String	(This function is only used in special scenarios. Contact your Allxon representative for instructions.) The serial number of the device behind a gateway, only required when sending commands to devices behind a gateway.
`"appGUID"`	String	The GUID of the plugin.
`"epoch"`	String	The current Epoch Time in seconds.
`"commandId"`	String	The assistId in MQTT message.
`"commandSource"`	String	`"remote"`
`"moduleName"`	String	The name of the module. The name must match the regular expression¹.
`"commands"`	Array	A set of modules.

`$.params.commands[*]`

Name	Type	Required	Description
`"name"`	String		The name of the command. The name must match the regular expression¹.
`"params"`	Array		A set of name and value pairs for the command.

`$.params.commands[].params[]`

Name	Type	Required	Description
`"name"`	String		The name of the parameter. The name must match the regular expression¹.
`"value"`	String \| Bool		The type of `"value"` depends on the `"displayType"` in the command parameter part of `"v2/notifyPluginUpdate"`. More details....

`"displayType":"string"` in `"commands"`

Based on the "displayType":"string" defined in "v2/notifyPluginUpdate", the Commands card displays a text box for the user to enter a string parameter.

command-display-type-string

See the JSON example below:

v2/notifyPluginUpdate.json
{
    ...
    "commands": [
        {
            "name": "command1",
            "params": [
                {
                    "name": "stringParam",
                    "displayType": "string",
                    "required": false,
                    ...
                }
            ],
            ...
        }
    ],
}

With this setting, the user can enter a string parameter, such as "foo" in the example below, and execute the command. command-display-type-string-exec

Then "v2/notifyPluginCommand" is sent out, carrying the command of "value": "foo".

v2/notifyPluginCommand.json
{
    ...
    "commands": [
        {
            "name": "command1",
            "params": [
               {
                  "name": "stringParam",
                  "value": "foo"
               }
            ]
        }
    ]
}

`"displayType":"datetime"` in `"commands"`

If "v2/notifyPluginUpdate" has "displayType":"datetime", you must define "displayFormat" by using one of the following formats:

"YYYY-MM-DD"
"HH:MM"
"YYYY-MM-DD HH:MM"

Then the Commands card on the Portal displays a corresponding field. Here is an example showing the field with "displayFormat" being "HH:MM"

command-display-type-date

See the JSON example below:

v2/notifyPluginUpdate.json
{
    ...
    "commands": [
        {
            "name": "command1",
            "params": [
                {
                    "name": "dateParam",
                    "displayType": "datetime",
                    "required": false,
                    "displayFormat": "HH:MM",
                    ...
                }
            ],
            ...
        }
    ],
}

When the user selects a time, for example “12:00”, and executes the command, "v2/notifyPluginCommand" is sent out. The value in the command follows the format of "displayFormat": "HH:MM"

command-display-type-date-selected

See the JSON example below:

v2/notifyPluginCommand.json
{
    ...
    "commands": [
        {
            "name": "command1",
            "params": [
               {
                  "name": "dateParam",
                  "value": "12:00"
               }
            ]
        }
    ]
}

`"displayType":"text"` in `"commands"`

If you set "displayType" to "text" in "v2/notifyPluginUpdate", the "value" in the command can contain multiple lines of parameters. The Commands card on the Portal displays a text parameter field.

command-display-type-text

See the JSON example below:

v2/notifyPluginUpdate.json
{
    ...
    "commands": [
        {
            "name": "command1",
            "params": [
                {
                    "name": "textParam",
                    "displayType": "text",
                    "required": false,
                    ...
                }
            ],
            ...
        }
    ],
}

Here is an example of how this works:

The user enters “hello world” in two lines and executes the command.

command-display-type-text-typed

This sends out "v2/notifyPluginCommand" with "value":"hello\nworld".

v2/notifyPluginCommand.json
{
    ...
    "commands": [
        {
            "name": "command1",
            "params": [
               {
                  "name": "dateParam",
                  "value": "hello\nworld"
               }
            ]
        }
    ]
}

`"displayType":"switch"` in `"commands"`

The switch function is used to switch between two parameters. The Commands card displays a toggle button for the user to make the change, as shown below.

command-display-type-switch

If you set "displayType" to "switch" in "v2/notifyPluginUpdate", you must define "displayValues" as a size 2 Array, with index 0 representing false and index 1 representing true.

v2/notifyPluginUpdate.json
{
    ...
    "commands": [
        {
            "name": "command1",
            "params": [
                {
                    "name": "switchParam",
                    "displayType": "switch",
                    "displayValues": [
                        "offValue",
                        "onValue"
                    ],
                    "defaultValue": "offValue",
                    "required": false,
                    ...
                }
            ],
            ...
        }
    ],
}

After the user executes the command, "v2/notifyPluginCommand" is sent out. The value in the command follows the "displayValues" defined in "v2/notifyPluginUpdate".

v2/notifyPluginCommand.json
{
    ...
    "commands": [
        {
            "name": "command1",
            "params": [
               {
                  "name": "switchParam",
                  "value": "offValue"
               }
            ]
        }
    ]
}

`"displayType":"checkbox"` in `"commands"`

The Commands card displays a checkbox for the user to enable or disable this parameter.

command-display-type-checkbox

If you set "displayType" to "checkbox" in "v2/notifyPluginUpdate", you must define "displayValues" as a size 2 Array, with index 0 representing false and index 1 representing true.

v2/notifyPluginUpdate.json
{
    ...
    "commands": [
        {
            "name": "command1",
            "params": [
                {
                    "name": "checkboxParam",
                    "displayType": "checkbox",
                    "displayValues": [
                        "offValue",
                        "onValue"
                    ],
                    "defaultValue": "offValue",
                    "required": false,
                    ...
                }
            ],
            ...
        }
    ],
}

After the user executes the command, "v2/notifyPluginCommand" is sent out. The value in the command follows the "displayValue" defined in "v2/notifyPluginUpdate".

v2/notifyPluginCommand.json
{
    ...
    "commands": [
        {
            "name": "command1",
            "params": [
               {
                  "name": "checkboxParam",
                  "value": "offValue"
               }
            ]
        }
    ]
}

`"displayType":"list"` in `"commands"`

The list function enables the user to select a parameter from a dropdown menu.

command-display-type-list

If you set "displayType" to "list" in "v2/notifyPluginUpdate", you must define "displayValues" as the "Array" type.

See the JSON example below.

v2/notifyPluginUpdate.json
{
    ...
    "commands": [
        {
            "name": "command1",
            "params": [
                {
                    "name": "listParam",
                    "displayType": "list",
                    "displayValues": [
                        "list1",
                        "list2"
                    ],
                    "required": false
                    ...
                }
            ],
            ...
        }
    ],
}

After the user executes the command, "v2/notifyPluginCommand" is sent out. The value in the command follows the "displayValues" defined in "v2/notifyPluginUpdate".

command-display-type-list-selected

See the JSON example below.

v2/notifyPluginCommand.json
{
    ...
    "commands": [
        {
            "name": "command1",
            "params": [
               {
                  "name": "listParam",
                  "value": "list1"
               }
            ]
        }
    ]
}

`"displayType":"tos"` in `"commands"`

"tos" stands for Terms of Service. Use this "displayType" if a command requires the user to agree to the Terms of Service before command execution. With this setting, the user agreement is mandatory on the Portal before the user can click the Execute button.

command-display-type-tos

If you set "displayType" to "tos" in "v2/notifyPluginUpdate", you must define "displayName" and description. Put your Terms of Service link in description.

See the JSON example below.

v2/notifyPluginUpdate.json
{
    ...
    "commands": [
        {
            "name": "command1",
            "params": [
                {
                    "name": "tosParam",
                    "displayType": "tos",
                    "displayName": "Terms of Service",
                    "description": "https://policies.google.com/terms?hl=en-US",
                    "required": true
                    ...
                }
            ],
            ...
        }
    ],
}

After the user executes the command, "v2/notifyPluginCommand" is sent out, carrying "value": false.

v2/notifyPluginCommand.json
{
    ...
    "commands": [
        {
            "name": "command1",
            "params": [
               {
                  "name": "tosParam",
                  "value": false
               }
            ]
        }
    ]
}

caution

The type of "value" is Bool.

`"v2/notifyPluginCommandAck"`

Direction: Plugin → Agent

{
    "jsonrpc": "2.0",
    "method": "v2/notifyPluginCommandAck",
    "params": {
        "serialNumber": "...",
        "appGUID": "...",
        "epoch": "...",
        "commandId": "...",
        "commandSource": "...",
        "moduleName": "...",
        "commandState": "...",
        "commandAcks": [
            {
                "name": "...",
                "result": { ... }
            }, ...
        ],
        "states": [
            {
                "name": "...",
                "value": "..."
            }, ...
        ]
    }
}

`$.params`

Name	Type	Description
`"serialNumber"`	String	( This function is only used in special scenarios. Contact your Allxon representative for instructions.) The serial number of the device behind a gateway, only required when you send commands to devices behind a gateway.
`"appGUID"`	String	The GUID of the plugin.
`"epoch"`	String	The current Epoch Time in seconds.
`"commandId"`	String	The same commandId retrieved from `"v2/notifyPluginCommand"`.
`"commandSource"`	String	The same commandSource retrieved from `"v2/notifyPluginCommand"`.
`"moduleName"`	String	The same moduleName retrieved from `"v2/notifyPluginCommand"`. The name must match the regular expression¹.
`"commandState"`	String	`"ACCEPTED"`: Plugin reports that a request for command execution is received. `"REJECTED"`: Plugin reports that the request for command execution is rejected. `"ACKED"`: Plugin reports that the command execution is completed. `"ERRORED"`: Plugin reports that the command execution failed.
`"commandAcks"`	Array
`"states"`	Array	The States that you want to update right after executing a command.

`$.params.commandAcks[*]`

Name	Type	Required	Description
`"name"`	String		The same command name retrieved from `"v2/notifyPluginCommand"`.
`"result"`	Object		The result of the command, defined by plugin.

`$.params.states[*]`

Name	Type	Description
`"name"`	String	The same command name retrieved from `"v2/notifyPluginCommand"`.
`"value"`	Object \| Array \| String	The type of `"value"` depends on the `"displayType"` in state part of `"v2/notifyPluginUpdate"`. More details....
`"time"`	String	The Epoch Time in seconds of the state.

`"v2/notifyPluginState"`

Direction: Plugin → Agent

{
    "jsonrpc": "2.0",
    "method": "v2/notifyPluginState",
    "params": {
        "appGUID": "...",
        "moduleName": "...",
        "epoch": "...",
        "states": [
            {
                "name": "...",
                "value": "..."
            }, ...
        ]
    }
}

`$.params`

Name	Type	Description
`"appGUID"`	String	The GUID of the plugin.
`"moduleName"`	String	The name of the module. The name must match the regular expression¹
`"epoch"`	String	The current Epoch Time in seconds.
`"states"`	Array	A set of states.

`$.params.states[*]`

Name	Type	Description
`"name"`	String	The name of the state.
`"value"`	Object \| Array \| String	The type of `"value"` depends on the `"displayType"` in state part of `"v2/notifyPluginUpdate"`. More details...
`"time"`	String	The current Epoch Time in seconds of the state.

`"displayType":"string"` in `"states"`

If "v2/notifyPluginUpdate" uses "displayType": "string", the state value is displayed in the string format.

v2/notifyPluginUpdate.json
{
    ...
    "states": [
        {
            "name": "stringState",
            "displayType": "string",
            ...
        },
        ...
    ]
}

state-display-type-string

Accordingly, when "v2/notifyPluginState" is sent to update the state value, The type of "value" must be String.

Example:

v2/notifyPluginState.json
{
    "jsonrpc": "2.0",
    "method": "v2/notifyPluginState",
    "params": {
        "states": [
            {
                "name": "stringState",
                "value": "my state string"
            },
            ...
        ]
    }
}

Then the States card is updated, as shown below.

state-display-type-string-exec

`"displayType":"link"` in `"states"`

If "v2/notifyPluginUpdate" uses "displayType": "link", the state value is a URL that leads to an external resource.

Example:

v2/notifyPluginUpdate.json
{
    ...
    "states": [
        {
            "name": "linkState",
            "displayType": "link",
            ...
        },
        ...
    ]
}

state-display-type-link

Accordingly, when "v2/notifyPluginState" is sent to update the state value, the type of "value" must be Object and follows the format below.

Name	Type	Required	Description
`url`	String		A link to an external resource.
`alias`	String		An alias name for this URL.

See the JSON example below:

v2/notifyPluginState.json
{
    "jsonrpc": "2.0",
    "method": "v2/notifyPluginState",
    "params": {
        ...
        "states": [
            {
                "name": "linkState",
                "value": {
                    "url": "https://www.google.com",
                    "alias": "Google Site"
                }
            },
            ...
        ]
    }
}

Then the States card is updated, as shown below. state-display-type-link-exec

`"displayType":"table"` in `"states"`

If "v2/notifyPluginUpdate" uses "displayType": "table", the state value is displayed in a table.

Example:

v2/notifyPluginUpdate.json
{
    ...
    "states": [
        {
            "name": "tableState",
            "displayType": "table",
            ...
        },
        ...
    ]
}

state-display-type-table

When "v2/notifyPluginState" is sent to update the state value, the type of "value" must be Array.

See the JSON example below:

v2/notifyPluginState.json
{
    "jsonrpc": "2.0",
    "method": "v2/notifyPluginState",
    "params": {
        ...
        "states": [
            {
                "name": "tableState",
                "value": [
                    {
                        "header1": "row1 column1",
                        "header2": "row1 column2"
                    },
                    {
                        "header1": "row2 column2",
                        "header2": "row2 column2"
                    }
                ]
            }
        ]
    }
}

Then, the States card displays a table icon.

state-display-type-table-exec

Just click the table icon to bring up a window to show the details.

state-display-type-table-popup

`"v2/notifyPluginMetric"`

Direction: Plugin → Agent

{
    "jsonrpc": "2.0",
    "method": "v2/notifyPluginMetric",
    "params": {
        "appGUID": "...",
        "moduleName": "...",
        "epoch": "...",
        "metrics": [
            {
                "name": "...",
                "value": "..."
            }, ...
        ]
    }
}

`$.params`

Name	Type	Description
`"appGUID"`	String	The GUID of the plugin.
`"moduleName"`	String	The name of the module, The name must match the regular expression¹.
`"epoch"`	String	The current Epoch Time in seconds.
`"metrics"`	Array	A set of metrics.

`$.params.metrics[*]`

Name	Type	Description
`"name"`	String	The name of the metric.
`"value"`	String	The type of `"value"` depends on the `"displayType"` in metric part of `"v2/notifyPluginUpdate"`. The number of value supports up to fifteen digits and two decimal places. Refer to Details.
`"time"`	String	The Epoch Time in seconds of the metrics.

`"displayType":"temperature"` in `"metrics"`

If the "displayType" is set to "temperature", the Portal displays a toggle button for switching between ^oF/^oC (Fahrenheit/ Celsius).

Example:

v2/notifyPluginUpdate.json
{
    ...
    "metrics": [
        {
            "name": "temperatureMetric",
            "displayType": "temperature",
            ...
        },
        ...
    ]
}

metric-display-type-temperature

When "v2/notifyPluginMetrics" is sent to update the metric value, the "value" SHOULD be reported in unit of Kelvin.

v2/notifyPluginMetric.json
{
    "jsonrpc": "2.0",
    "method": "v2/notifyPluginMetric",
    "params": {
        ...
        "metrics": [
            {
                "name": "temperatureMetric",
                "value": "298"
            },
            ...
        ]
    }
}

The Portal converts the metric unit from Kelvin to Fahrenheit and Celsius.

metric-display-type-temperature-exec

`"displayType":"custom"` in `"metrics"`

If "displayType" is set to "custom", you must define "displayUnit" as the unit of the metrics.

See the JSON example below:

v2/notifyPluginUpdate.json
{
    ...
    "metrics": [
        {
            "name": "customMetric",
            "displayType": "custom",
            "displayUnit": "degree",
            ...
        },
        ...
    ]
}

metric-display-type-temperature

Use "v2/notifyPluginMetrics" to update the metric value. See the JSON example below:

v2/notifyPluginMetric.json
{
    "jsonrpc": "2.0",
    "method": "v2/notifyPluginMetric",
    "params": {
        ...
        "metrics": [
            {
                "name": "customMetric",
                "value": "30"
            },
            ...
        ]
    }
}

The Charts card is updated accordingly, as shown below.

metric-display-type-custom-exec

`"v2/notifyPluginEvent"`

Direction: Plugin → Agent

{
    "jsonrpc": "2.0",
    "method": "v2/notifyPluginEvent",
    "params": {
        "appGUID": "...",
        "moduleName": "...",
        "epoch": "...",
        "events": [
            {
                "name": "...",
                "value": "..."
            }, ...
        ]
    }
}

`$.params`

Name	Type	Description
`"appGUID"`	String	The GUID of the plugin.
`"moduleName"`	String	The name of the module. The name must match the regular expression¹
`"epoch"`	String	The current Epoch Time in seconds.
`"events"`	Array	A set of events

`$.params.events[*]`

Name	Type	Description
`"name"`	String	The name of the event.
`"value"`	String	The value of the event.
`"time"`	String	The Epoch Time in seconds of the event.

`"v2/notifyPluginConfigUpdate"`

Direction: Agent → Plugin

{
    "jsonrpc": "2.0",
    "method": "v2/notifyPluginConfigUpdate",
    "params": {
        "appGUID": "...",
        "epoch": "...",
        "version": "...",
        "modules": [
            {
                "moduleName": "...",
                "epoch": "...",
                "configs": [
                    {
                        "name": "...",
                        "params": [
                            {
                                "name": "...",
                                "value": "..."
                            },
                            ...
                        ]
                    },
                    ...
                ]
            }
        ]
    }
}

`$.params`

Name	Type	Description
`"appGUID"`	String	The GUID of the plugin.
`"epoch"`	String	The current Epoch Time in seconds.
`"version"`	String	The version of the plugin config.
`"modules"`	Array	A set of modules.

`$.params.modules[*]`

Name	Type	Description
`"moduleName"`	String	The name of the module. The name must match the regular expression¹.
`"epoch"`	String	The Epoch time in seconds when an update is made. Plugin should update the module’s config based on the latest Epoch time.
`"configs"`	Array	A set of configs.

`$.params.modules[].configs[]`

Name	Type	Required	Description
`"name"`	String		The name of the config. The name must match the regular expression¹.
`"params"`	Array		A set of name and value pairs for the configs. The maximum total size of the configs is up to 1024 bytes.

`$.params.modules[].configs[].params[*]`

Name	Type	Required	Description
`"name"`	String		The name of the parameter. The name must match the regular expression¹.
`"value"`	String		The type of `"value"` depends on the `"displayType"` in configs part of `"v2/notifyPluginUpdate"`. More details.

`"displayType":"string"` in `"configs"`

Based on "displayType": "string" defined in "v2/notifyPluginUpdate", the Configs card displays a text box for the user to enter a string parameter.

config-display-type-string

See the JSON example below:

v2/notifyPluginUpdate.json
{
    ...
    "configs": [
        {
            "name": "config1",
            "params": [
                {
                    "name": "stringParam",
                    "displayType": "string",
                    "required": false,
                    ...
                },
                ...
            ],
            ...
        }
    ],
}

The user can enter a string parameter, such as “foo” in the example below, and update the parameter on the Configs card.

config-display-type-string-exec

Then "v2/notifyPluginConfigUpdate" is sent out, carrying the config of "value": "foo".

v2/notifyPluginConfigUpdate.json
{
    "jsonrpc": "2.0",
    "method": "v2/notifyPluginConfigUpdate",
    ...
        ...
            ...
                "configs": [
                    {
                        "name": "config1",
                        "params": [
                            {
                                "name": "stringParam",
                                "value": "foo"
                            }
                            ...
                        ]
                        ...
                    }
                    ...
                ]
}

`"displayType":"datetime"` in `"configs"`

If "v2/notifyPluginUpdate" uses "displayType": "datetime", you must define "displayFormat" using one of the following formats:

"YYYY-MM-DD"
"HH:MM"
"YYYY-MM-DD HH:MM"

See the JSON example below.

v2/notifyPluginUpdate.json
{
    ...
    "configs": [
        {
            "name": "config1",
            "params": [
                {
                    "name": "datetimeParam",
                    "displayType": "datetime",
                    "displayFormat": "HH:MM",
                    "required": false,
                    ...
                },
                ...
            ],
            ...
        }
    ],
}

config-display-type-datetime

When the user selects a time, for example "06:00” and executes the command, "v2/notifyPluginConfigUpdate" is sent out. The "value" in the update follows the format of "displayFormat": "HH:MM".

config-display-type-datetime-exec

See the JSON example below:

v2/notifyPluginConfigUpdate.json
{
    "jsonrpc": "2.0",
    "method": "v2/notifyPluginConfigUpdate",
    ...
        ...
            ...
                "configs": [
                    {
                        "name": "config1",
                        "params": [
                            {
                                "name": "datetimeParam",
                                "value": "06:00"
                            }
                            ...
                        ]
                        ...
                    }
                    ...
                ]
}

`"displayType":"switch"` in `"configs"`

The switch function is used to switch between two parameters. The Configs card displays a toggle switch for the user to make the change, as shown below.

config-display-type-switch

See the JSON example as below.

v2/notifyPluginUpdate.json
{
    ...
    "configs": [
        {
            "name": "config1",
            "params": [
                {
                    "name": "switchParam",
                    "displayType": "switch",
                    "displayValues": [
                        "offValue",
                        "onValue"
                    ],
                    "defaultValue": "offValue",
                    "required": false,
                    ...
                }
            ],
            ...
        }
    ],
}

After the user updates the config, "v2/notifyPluginConfigUpdate" is sent out. The value in the command follows the "displayValues" defined in "v2/notifyPluginUpdate".

v2/notifyPluginConfigUpdate.json
{
    "jsonrpc": "2.0",
    "method": "v2/notifyPluginConfigUpdate",
    ...
        ...
            ...
                "configs": [
                    {
                        "name": "config1",
                        "params": [
                            {
                                "name": "switchParam",
                                "value": "offValue"
                            }
                            ...
                        ]
                        ...
                    }
                    ...
                ]
}

`"displayType":"checkbox"` in `"configs"`

The Configs card displays a checkbox for the user to enable or disable the parameter.

config-display-type-checkbox

If you set "displayType" to "checkbox" in "v2/notifyPluginUpdate", you must define "displayValues" as a size 2 Array, with index 0 representing false, index 1 representing true.

v2/notifyPluginUpdate.json
{
    ...
    "configs": [
        {
            "name": "config1",
            "params": [
                {
                    "name": "checkboxParam",
                    "displayType": "checkbox",
                    "displayValues": [
                        "offValue",
                        "onValue"
                    ],
                    "defaultValue": "offValue",
                    "required": false,
                    ...
                }
            ],
            ...
        }
    ],
}

After the user updates the config, "v2/notifyPluginConfigUpdate" is sent out. The value in the update follows the "displayValues" defined in "v2/notifyPluginUpdate".

v2/notifyPluginConfigUpdate.json
{
    "jsonrpc": "2.0",
    "method": "v2/notifyPluginConfigUpdate",
    ...
        ...
            ...
                "configs": [
                    {
                        "name": "config1",
                        "params": [
                            {
                                "name": "checkboxParam",
                                "value": "offValue"
                            }
                            ...
                        ]
                        ...
                    }
                    ...
                ]
}

`"displayType":"list"` in `"configs"`

The list function enables the user to select a parameter from a dropdown menu.

config-display-type-list

If you set "displayType" to "list" in "v2/notifyPluginUpdate" , you must define "displayValues" as the Array type.

See the JSON example below:

v2/notifyPluginUpdate.json
{
    ...
    "configs": [
        {
            "name": "config1",
            "params": [
                {
                    "name": "listParam",
                    "displayType": "list",
                    "displayValues": [
                        "list1",
                        "list2"
                    ],
                    "defaultValue": "list1",
                    "required": false,
                    ...
                }
            ],
            ...
        }
    ],
}

After the user updates the config, "v2/notifyPluginConfigUpdate" is sent out. The value in the update follows the "displayValues" defined in "v2/notifyPluginUpdate".

See the JSON example below:

config-display-type-list-exec

v2/notifyPluginConfigUpdate.json
{
    "jsonrpc": "2.0",
    "method": "v2/notifyPluginConfigUpdate",
    ...
        ...
            ...
                "configs": [
                    {
                        "name": "config1",
                        "params": [
                            {
                                "name": "listParam",
                                "value": "list1"
                            }
                            ...
                        ]
                        ...
                    }
                    ...
                ]
}

`"displayType":"temperature"` in `"configs"`

If you set "displayType" to "temperature", the user can enter temperature parameters in Fahrenheit or Celsius.

config-display-type-temperature

See the JSON example below:

v2/notifyPluginUpdate.json
{
    ...
    "configs": [
        {
            "name": "config1",
            "params": [
                {
                    "name": "temperatureParam",
                    "displayType": "temperature",
                    "required": false,
                    ...
                }
            ],
            ...
        }
    ],
}

Please note that while the user uses the Fahrenheit or Celsius scale on the Portal, the temperature scale sent to the plugin needs to be Kelvin.

Example:

The user enters “28 ^oC” on the Configs card. However, v2/notifyPluginConfigUpdate.json shows "value":"301.15".

config-display-type-temperature-exec

v2/notifyPluginConfigUpdate.json
{
    "jsonrpc": "2.0",
    "method": "v2/notifyPluginConfigUpdate",
    ...
        ...
            ...
                "configs": [
                    {
                        "name": "config1",
                        "params": [
                            {
                                "name": "temperatureParam",
                                "value": "301.15"
                            }
                            ...
                        ]
                        ...
                    }
                    ...
                ]
}

`"v2/notifyPluginAlarmUpdate"`

Direction: Agent → Plugin

{
    "jsonrpc": "2.0",
    "method": "v2/notifyPluginAlarmUpdate",
    "params": {
        "appGUID": "...",
        "epoch": "...",
        "version": "...",
        "modules": [
            {
                "moduleName": "...",
                "epoch": "...",
                "alarms": [
                    {
                        "name": "...",
                        "enabled": true,
                        "params": [
                            {
                                "name": "...",
                                "value": "..."
                            },
                            ...
                        ]
                    },
                    ...
                ]
            }
        ]
    }
}

`$.params`

Name	Type	Description
`"appGUID"`	String	The GUID of the plugin.
`"epoch"`	String	The current Epoch Time in seconds.
`"version"`	String	The version of the plugin alarm.
`"modules"`	Array	A set of modules.

`$.params.modules[*]`

Name	Type	Description
`"moduleName"`	String	The name of the module. The name must match the regular expression¹.
`"epoch"`	String	The Epoch time in seconds when an update is made. Plugin should update the module’s alarms based on the latest Epoch time.
`"alarms"`	Array	A set of alarms.

`$.params.modules[].alarms[]`

Name	Type	Description
`"name"`	String	The name of the alarm. The name must match the regular expression¹.
`"enabled"`	Bool	Alarm is enabled.
`"params"`	Array	A set of name and value pairs for the alarm. The maximum total size of the alarm is up to 1024 bytes

`$.params.modules[].alarms[].params[*]`

Name	Type	Required	Description
`"name"`	String		The name of the parameter. The name must match the regular expression¹.
`"value"`	String		The type of `"value"` depends on the `"displayType"` in alarm part of `"v2/notifyPluginUpdate"`. More details.

`"displayType":"string"` in `"alarms"`

Based on "displayType": "string" defined in "v2/notifyPluginUpdate", the Alert Settings card displays a text box for the user to enter a string parameter.

alarm-display-type-string

See the JSON example below:

v2/notifyPluginUpdate.json
{
    ...
    "alarms": [
        {
            "name": "alarm1",
            "params": [
                {
                    "name": "stringParam",
                    "displayType": "string",
                    "required": false,
                    ...
                },
                ...
            ],
            ...
        }
    ],
}

The user can enter a string parameter, such as "foo” in the example below, and update the parameter on the Alert Settings card.

alarm-display-type-string-exec

Then "v2/notifyPluginAlarmUpdate" is sent out, carrying "value": "foo".

v2/notifyPluginAlarmUpdate.json
{
    "jsonrpc": "2.0",
    "method": "v2/notifyPluginAlarmUpdate",
    ...
        ...
            ...
                "alarms": [
                    {
                        "name": "alarm1",
                        "params": [
                            {
                                "name": "stringParam",
                                "value": "foo"
                            }
                            ...
                        ]
                        ...
                    }
                    ...
                ]
}

`"displayType":"datetime"` in `"alarms"`

If "v2/notifyPluginUpdate" uses "displayType": "datetime", you must define "displayFormat" using one of the following formats:

"YYYY-MM-DD"
"HH:MM"
"YYYY-MM-DD HH:MM"

alarm-display-type-datetime

See the JSON example below:

v2/notifyPluginUpdate.json
{
    ...
    "alarms": [
        {
            "name": "alarm1",
            "params": [
                {
                    "name": "datetimeParam",
                    "displayType": "datetime",
                    "displayFormat": "HH:MM",
                    "required": false,
                    ...
                },
                ...
            ],
            ...
        }
    ],
}

When the user selects a time, for example "06:00”, to update the alert setting, "v2/notifyPluginAlarmUpdate" is sent out. The "value" in the update follows the format of "displayFormat": "HH:MM".

alarm-display-type-datetime-exec

See the JSON example below:

v2/notifyPluginAlarmUpdate.json
{
    "jsonrpc": "2.0",
    "method": "v2/notifyPluginAlarmUpdate",
    ...
        ...
            ...
                "alarms": [
                    {
                        "name": "alarm1",
                        "params": [
                            {
                                "name": "datetimeParam",
                                "value": "06:00"
                            }
                            ...
                        ]
                        ...
                    }
                    ...
                ]
}

`"displayType":"switch"` in `"alarms"`

The switch function is used to switch between two parameters. The Alert Settings card displays a toggle button for the user to make the change, as shown below.

alarm-display-type-switch

If you set "displayType" to "switch" in "v2/notifyPluginUpdate", you must define "displayValues" as a size 2 Array, with index 0 representing false and index 1 representing true.

v2/notifyPluginUpdate.json
{
    ...
    "alarms": [
        {
            "name": "alarm1",
            "params": [
                {
                    "name": "switchParam",
                    "displayType": "switch",
                    "displayValues": [
                        "offValue",
                        "onValue"
                    ],
                    "defaultValue": "offValue",
                    "required": false,
                    ...
                }
            ],
            ...
        }
    ],
}

After the user updates the alert settings, "v2/notifyPluginAlarmUpdate" is sent out. The value in the update follows the "displayValues" defined in "v2/notifyPluginUpdate".

v2/notifyPluginAlarmUpdate.json
{
    "jsonrpc": "2.0",
    "method": "v2/notifyPluginAlarmUpdate",
    ...
        ...
            ...
                "alarms": [
                    {
                        "name": "alarm1",
                        "params": [
                            {
                                "name": "switchParam",
                                "value": "offValue"
                            }
                            ...
                        ]
                        ...
                    }
                    ...
                ]
}

`"displayType":"checkbox"` in `"alarms"`

The Alert Settings card displays a checkbox for the user to enable or disable the parameter.

alarm-display-type-checkbox

If you set "displayType" to "checkbox" in "v2/notifyPluginUpdate", you must define "displayValues" as a size 2 Array, with index 0 representing false and index 1 representing true.

v2/notifyPluginUpdate.json
{
    ...
    "alarms": [
        {
            "name": "alarm1",
            "params": [
                {
                    "name": "checkboxParam",
                    "displayType": "checkbox",
                    "displayValues": [
                        "offValue",
                        "onValue"
                    ],
                    "defaultValue": "offValue",
                    "required": false,
                    ...
                }
            ],
            ...
        }
    ],
}

After the user updates the alert settings, "v2/notifyPluginAlarmUpdate" is sent out. The value in the update follows the "displayValues" defined in "v2/notifyPluginUpdate"

v2/notifyPluginAlarmUpdate.json
{
    "jsonrpc": "2.0",
    "method": "v2/notifyPluginAlarmUpdate",
    ...
        ...
            ...
                "alarms": [
                    {
                        "name": "alarm1",
                        "params": [
                            {
                                "name": "checkboxParam",
                                "value": "offValue"
                            }
                            ...
                        ]
                        ...
                    }
                    ...
                ]
}

`"displayType":"list"` in `"alarms"`

The list function enables the user to select a parameter from a dropdown menu on the Alert Settings card.

alarm-display-type-list

If you set "displayType" to "list" in "v2/notifyPluginUpdate", you must define "displayValues" as the Array type.

See the JSON example below:

v2/notifyPluginUpdate.json
{
    ...
    "alarms": [
        {
            "name": "alarm1",
            "params": [
                {
                    "name": "listParam",
                    "displayType": "list",
                    "displayValues": [
                        "list1",
                        "list2"
                    ],
                    "defaultValue": "list1",
                    "required": false,
                    ...
                }
            ],
            ...
        }
    ],
}

After the user updates the alert settings, "v2/notifyPluginAlarmUpdate" is sent out. The value in the update follows the "displayValues" defined in "v2/notifyPluginUpdate".

alarm-display-type-list-exec

See the JSON example below:

v2/notifyPluginAlarmUpdate.json
{
    "jsonrpc": "2.0",
    "method": "v2/notifyPluginAlarmUpdate",
    ...
        ...
            ...
                "alarms": [
                    {
                        "name": "alarm1",
                        "params": [
                            {
                                "name": "listParam",
                                "value": "list1"
                            }
                            ...
                        ]
                        ...
                    }
                    ...
                ]
}

`"displayType":"temperature"` in `"alarms"`

If you set "displayType" to "temperature", the user can enter temperature parameters in Fahrenheit or Celsius.

alarm-display-type-temperature

See the JSON example below:

v2/notifyPluginUpdate.json
{
    ...
    "alarms": [
        {
            "name": "alarm1",
            "params": [
                {
                    "name": "temperatureParam",
                    "displayType": "temperature",
                    "required": false,
                    ...
                }
            ],
            ...
        }
    ],
}

Please note that while the user uses the Fahrenheit or Celsius scale on the Portal, the temperature scale sent to the plugin needs to be Kelvin.

Example:

The user enters 28^oC on the Alert Settings card. However, v2/notifyPluginAlarmUpdate.json shows "value":"301.15".

alarm-display-type-temperature-exec

v2/notifyPluginAlarmUpdate.json
{
    "jsonrpc": "2.0",
    "method": "v2/notifyPluginAlarmUpdate",
    ...
        ...
            ...
                "alarms": [
                    {
                        "name": "alarm1",
                        "params": [
                            {
                                "name": "temperatureParam",
                                "value": "301.15"
                            }
                            ...
                        ]
                        ...
                    }
                    ...
                ]
}

`"v2/notifyPluginAlert"`

Direction: Plugin → Agent

{
    "jsonrpc": "2.0",
    "method": "v2/notifyPluginAlert",
    "params": {
        "appGUID": "...",
        "moduleName": "...",
        "epoch": "...",
        "alarms": [
            {
                "name": "...",
                "action": "...",
                "time": "...",
                "message": "..."
            }, ...
        ]
    }
}

`$.params`

Name	Type	Description
`"appGUID"`	String	The GUID of the plugin.
`"moduleName"`	String	The name of the module. The name must match the regular expression¹.
`"epoch"`	String	The current Epoch Time in seconds.
`"alarms"`	Array	A set of alarms.

`$.params.alarms[*]`

Name	Type	Description
`"name"`	String	The name of the alarm. The name must match the regular expression¹.
`"action"`	String	`"trigger"`: When the alarm has been triggered. `"resolve"`: When the alarm has been resolved.
`"time"`	String	The Epoch Time in seconds of the action.
`"message"`	String	The content to be sent through available alert channels, e.g. email.

API Error Codes

`$.error`

Name	Type	Required	Description
`"code"`	String		A number that indicates the type of an occurred error.
`"message"`	String		A String that provides a short description of the error.

Example:

{
  "jsonrpc": "2.0",
  "error": {
    "code": "-326000",
    "message": "The JSON sent is not a valid Request object."
  },
  "id": null
}

Error Codes

Code	Status	Message
`-320000`	`Device offline`	If agent cannot send the request to MQTT, return device offline.
`-326000`	`Invalid Request (sign error or time error)`	The JSON sent is not a valid Request object.
`-327000`	`Parse error`	Invalid JSON was received by the server. An error occurred on the server while parsing the JSON text.

regular expression: ^[a-zA-Z][a-zA-Z0-9_-]*$. ↩ ↩² ↩³ ↩⁴ ↩⁵ ↩⁶ ↩⁷ ↩⁸ ↩⁹ ↩¹⁰ ↩¹¹ ↩¹² ↩¹³ ↩¹⁴ ↩¹⁵ ↩¹⁶ ↩¹⁷ ↩¹⁸ ↩¹⁹ ↩²⁰ ↩²¹ ↩²² ↩²³ ↩²⁴ ↩²⁵ ↩²⁶
regular expression: ^[0-9]+[.][0-9]+[.][0-9]+$. ↩

Glossary of Terms​

Allxon Octo API​

How to Read the API​

"v2/notifyPluginUpdate"​

$.params​

$.params.modules[*]​

$.params.modules[*].properties[*]​

"displayType":"string" in "properties"​

"displayType":"link" in "properties"​

"displayType":"table" in "properties"​

$.params.modules[*].states[*]​

$.params.modules[*].metrics[*]​

$.params.modules[*].events[*]​

$.params.modules[*].commands[*]​

$.params.modules[*].commands[*].params[*]​

$.params.modules[*].alarms[*]​

$.params.modules[*].alarms[*].params[*]​

$.params.modules[*].configs[*]​

$.params.modules[*].configs[*].params[*]​

"v2/notifyPluginCommand"​

$.params​

$.params.commands[*]​

$.params.commands[*].params[*]​

"displayType":"string" in "commands"​

"displayType":"datetime" in "commands"​

"displayType":"text" in "commands"​

"displayType":"switch" in "commands"​

"displayType":"checkbox" in "commands"​

"displayType":"list" in "commands"​

"displayType":"tos" in "commands"​

"v2/notifyPluginCommandAck"​

$.params​

$.params.commandAcks[*]​

$.params.states[*]​

"v2/notifyPluginState"​

$.params​

$.params.states[*]​

"displayType":"string" in "states"​

"displayType":"link" in "states"​

"displayType":"table" in "states"​

"v2/notifyPluginMetric"​

$.params​

$.params.metrics[*]​

"displayType":"temperature" in "metrics"​

"displayType":"custom" in "metrics"​

"v2/notifyPluginEvent"​

$.params​

$.params.events[*]​

"v2/notifyPluginConfigUpdate"​

$.params​

$.params.modules[*]​

$.params.modules[*].configs[*]​

$.params.modules[*].configs[*].params[*]​

"displayType":"string" in "configs"​

"displayType":"datetime" in "configs"​

"displayType":"switch" in "configs"​

"displayType":"checkbox" in "configs"​

"displayType":"list" in "configs"​

"displayType":"temperature" in "configs"​

"v2/notifyPluginAlarmUpdate"​

$.params​

$.params.modules[*]​

$.params.modules[*].alarms[*]​

$.params.modules[*].alarms[*].params[*]​

"displayType":"string" in "alarms"​

"displayType":"datetime" in "alarms"​

"displayType":"switch" in "alarms"​

"displayType":"checkbox" in "alarms"​

"displayType":"list" in "alarms"​

"displayType":"temperature" in "alarms"​

"v2/notifyPluginAlert"​

$.params​

$.params.alarms[*]​

API Error Codes​

$.error​

Error Codes​

Footnotes​

Glossary of Terms

Allxon Octo API

How to Read the API

`"v2/notifyPluginUpdate"`

`$.params`

`$.params.modules[*]`

`$.params.modules[].properties[]`

`"displayType":"string"` in `"properties"`

`"displayType":"link"` in `"properties"`

`"displayType":"table"` in `"properties"`

`$.params.modules[].states[]`

`$.params.modules[].metrics[]`

`$.params.modules[].events[]`

`$.params.modules[].commands[]`

`$.params.modules[].commands[].params[*]`

`$.params.modules[].alarms[]`

`$.params.modules[].alarms[].params[*]`

`$.params.modules[].configs[]`

`$.params.modules[].configs[].params[*]`

`"v2/notifyPluginCommand"`

`$.params`

`$.params.commands[*]`

`$.params.commands[].params[]`

`"displayType":"string"` in `"commands"`

`"displayType":"datetime"` in `"commands"`

`"displayType":"text"` in `"commands"`

`"displayType":"switch"` in `"commands"`

`"displayType":"checkbox"` in `"commands"`

`"displayType":"list"` in `"commands"`

`"displayType":"tos"` in `"commands"`

`"v2/notifyPluginCommandAck"`

`$.params`

`$.params.commandAcks[*]`

`$.params.states[*]`

`"v2/notifyPluginState"`

`$.params`

`$.params.states[*]`

`"displayType":"string"` in `"states"`

`"displayType":"link"` in `"states"`

`"displayType":"table"` in `"states"`

`"v2/notifyPluginMetric"`

`$.params`

`$.params.metrics[*]`

`"displayType":"temperature"` in `"metrics"`

`"displayType":"custom"` in `"metrics"`

`"v2/notifyPluginEvent"`

`$.params`

`$.params.events[*]`

`"v2/notifyPluginConfigUpdate"`

`$.params`

`$.params.modules[*]`

`$.params.modules[].configs[]`

`$.params.modules[].configs[].params[*]`

`"displayType":"string"` in `"configs"`

`"displayType":"datetime"` in `"configs"`

`"displayType":"switch"` in `"configs"`

`"displayType":"checkbox"` in `"configs"`

`"displayType":"list"` in `"configs"`

`"displayType":"temperature"` in `"configs"`

`"v2/notifyPluginAlarmUpdate"`

`$.params`

`$.params.modules[*]`

`$.params.modules[].alarms[]`

`$.params.modules[].alarms[].params[*]`

`"displayType":"string"` in `"alarms"`

`"displayType":"datetime"` in `"alarms"`

`"displayType":"switch"` in `"alarms"`

`"displayType":"checkbox"` in `"alarms"`

`"displayType":"list"` in `"alarms"`

`"displayType":"temperature"` in `"alarms"`

`"v2/notifyPluginAlert"`

`$.params`

`$.params.alarms[*]`

API Error Codes

`$.error`

Error Codes

Footnotes